doc: add documentation on naming functions in a Kptfile #4010
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
site/book/04-using-functions/01-declarative-function-execution.md
Outdated
Show resolved
Hide resolved
site/book/04-using-functions/01-declarative-function-execution.md
Outdated
Show resolved
Hide resolved
natasha41575
approved these changes
Aug 14, 2023
|
Thanks! Will merge this once the tests finish. |
johnbelamaric
pushed a commit
to mortent/kpt
that referenced
this pull request
Sep 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR documents/clarifies that using
nameon functions in aKptfileis important when updating packages withkpt pkg update. The issue was discussed in Slack here: https://kubernetes.slack.com/archives/C0155NSPJSZ/p1689926397556699The
namefield was not mentioned in the current version of the book, and since function lists are merged as associative lists, the effect of not specifying anamemay result in unpredictable ordering of the function lists.Specifically, the PR updates section 4.1 of the kpt book on "Declarative Function Execution"
A few considerations for reviewers:
image. This PR does not describe this situation since there are multiple requirements for this to be possible. Also, I'm suspecting that this functionality may no longer be active since the example shown in the Slack thread should have merged the updated function list if it had usedimageas identifier.